set lien on an account

PATCH /api/v1/Accounts/set-lien

Description

This endpoint is used to set a lien on an account. A lien is a legal claim on an asset that allows the lienholder to obtain repayment before the asset is sold or transferred to another party.

Request

• Path Parameters:

  • version: API version (string)

• Headers:

  • Accept-Language: Change default response message language from English(en). Available languages fr,en

• Request Body:

  • SetLienOnAccountCommand: Represents the command to set a lien on an account (object)

Responses

• 200: Success. Returns a StringResponse.

• 400: Bad Request. The request is not valid.

Examples

Request

httpCopy codePATCH /api/v{version}/Accounts/set-lien HTTP/1.1
Host: example.com
Accept-Language: en
Content-Type: application/json
{
  "accountId": "1234",
  "reason": "Account owner is in default on a loan",
  "notes": "This lien is being set as a result of the account owner defaulting on a loan."
}

Response

httpCopy codeHTTP/1.1 200 OK
{
  "message": "Lien has been successfully set on the account."
}

Error Response

httpCopy codeHTTP/1.1 400 Bad Request
{
  "message": "Invalid account ID."
}

/api/v`{{version}}`/Accounts/set-lien

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "accountNumber": `<string>`,
  "amount": `<double>`
}

Response: 200

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

Response: 400

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}